/*
 * Copyright (c) 2010, Jim Hollinger
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Jim Hollinger nor the names of its contributors
 *     may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef COMMON_NMEA0183_NMEA0183PARSER_H_
#define COMMON_NMEA0183_NMEA0183PARSER_H_

#include <queue>

namespace nmea0183 {

class Nmea0183Message;

class Nmea0183Parser {
  public:
    enum {
        NMEA0183_MAX_SENTENCE_LEN = 4096,
        NMEA0183_TALKER_LEN = 2,
        NMEA0183_MSG_TYPE_LEN = 3,
        NMEA0183_TALKER_MSG_TYPE_LEN = NMEA0183_TALKER_LEN +
                                       NMEA0183_MSG_TYPE_LEN +
                                       1,  // plus 1 for start char
    };

    enum Nmea0183ParserState {
        NMEA0183_PARSER_NEED_START = 0,
        NMEA0183_PARSER_NEED_1ST_COMMA,
        NMEA0183_PARSER_NEED_END,
        NMEA0183_PARSER_SENTENCE,
    };

  public:
    Nmea0183Parser();
    ~Nmea0183Parser();
    bool parse(const char *data);
    bool parse(const char *data, int len);
    Nmea0183Message *getNextMessage();
    void deleteMessage(Nmea0183Message *msg);
    void printParams();
    static void printParams(const char **params, int numParams);
    static unsigned int computeChecksum(const char *sentence);
    static bool verifyChecksum(const char *sentence);
    static bool unitTest();

  protected:
    bool parseSentence(const char *sentence);
    bool parseParams();

  public:
    static const char   NMEA0183_START_CHAR;
    static const char   NMEA0183_COMMA_CHAR;
    static const char   NMEA0183_CHECKSUM_CHAR;
    static const char   NMEA0183_END_CHAR1;
    static const char   NMEA0183_END_CHAR2;

  protected:
    bool                valid_flag;
    Nmea0183ParserState state;

    char               *chars;
    int                 maxNumChars;
    int                 numChars;

    char              **params;
    int                 maxParamLen;
    int                 maxNumParams;
    int                 numParams;

    std::queue<Nmea0183Message *> msgQueue;
};

}  // namespace nmea0183

#endif  // COMMON_NMEA0183_NMEA0183PARSER_H_
